Azure Communication Chat Service (stable:2025-03-15)

2025/07/24 • 8 updated methods

ChatThread_ListChatReadReceipts (updated)
Description :  Gets chat message read receipts for a thread.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ChatThread_ListChatReadReceipts",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "senderCommunicationIdentifier": [
              {
                "#name": "kind",
                "Enum": {
                  "new": [
                    [
                      "unknown",
                      ""
                    ],
                    [
                      "communicationUser",
                      ""
                    ],
                    [
                      "phoneNumber",
                      ""
                    ],
                    [
                      "microsoftTeamsUser",
                      ""
                    ],
                    [
                      "microsoftTeamsApp",
                      ""
                    ],
                    [
                      "teamsExtensionUser",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "unknown",
                      ""
                    ],
                    [
                      "communicationUser",
                      ""
                    ],
                    [
                      "phoneNumber",
                      ""
                    ],
                    [
                      "microsoftTeamsUser",
                      ""
                    ],
                    [
                      "microsoftTeamsApp",
                      ""
                    ]
                  ]
                }
              },
              {
                "phoneNumber": [
                  {
                    "#name": "value",
                    "Description": {
                      "new": "The phone number, usually in E.164 format.",
                      "old": "The phone number in E.164 format."
                    }
                  },
                  {
                    "@added_c1cd173599f344bc8062b1e50268b896": {
                      "#name": "isAnonymous",
                      "Description": "True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.",
                      "Required": false,
                      "Type": "boolean"
                    }
                  },
                  {
                    "@added_dd9bea071a5d4830bfe415ee80f25442": {
                      "#name": "assertedId",
                      "Description": "The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.",
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              },
              {
                "microsoftTeamsUser": [
                  {
                    "#name": "userId",
                    "Description": {
                      "new": "The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.",
                      "old": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user."
                    }
                  }
                ]
              },
              {
                "@added_a39eeed1e6e9470a982eb3f7e45fe00e": {
                  "#name": "teamsExtensionUser",
                  "Description": "The Microsoft Teams Extension user.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "userId",
                      "Description": "The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "tenantId",
                      "Description": "The tenant Id of the Microsoft Teams Extension user.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceId",
                      "Description": "The Communication Services resource Id.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "cloud",
                      "Description": "The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing.",
                      "Enum": [
                        [
                          "public",
                          ""
                        ],
                        [
                          "dod",
                          ""
                        ],
                        [
                          "gcch",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /chat/threads/{chatThreadId}/readReceipts
{
chatThreadId:
{
Description: Thread id to get the chat message read receipts for. ,
Required: True ,
}
string ,
maxPageSize:
{
Description: The maximum number of chat message read receipts to be returned per page. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: Skips chat message read receipts up to a specified position in response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of chat message read receipts. ,
Required: True ,
}
[
{
senderCommunicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
chatMessageId:
{
Description: Id of the chat message that has been read. This id is generated by the server. ,
Required: True ,
}
string ,
readOn:
{
Description: The time at which the message was read. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: If there are more chat message read receipts that can be retrieved, the next link will be populated. ,
Required: False ,
}
string ,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_ListChatMessages (updated)
Description :  Gets a list of messages from a thread.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ChatThread_ListChatMessages",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "content": [
              {
                "participants": {
                  "$properties": {
                    "communicationIdentifier": [
                      {
                        "#name": "kind",
                        "Enum": {
                          "new": [
                            [
                              "unknown",
                              ""
                            ],
                            [
                              "communicationUser",
                              ""
                            ],
                            [
                              "phoneNumber",
                              ""
                            ],
                            [
                              "microsoftTeamsUser",
                              ""
                            ],
                            [
                              "microsoftTeamsApp",
                              ""
                            ],
                            [
                              "teamsExtensionUser",
                              ""
                            ]
                          ],
                          "old": [
                            [
                              "unknown",
                              ""
                            ],
                            [
                              "communicationUser",
                              ""
                            ],
                            [
                              "phoneNumber",
                              ""
                            ],
                            [
                              "microsoftTeamsUser",
                              ""
                            ],
                            [
                              "microsoftTeamsApp",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "phoneNumber": [
                          {
                            "#name": "value",
                            "Description": {
                              "new": "The phone number, usually in E.164 format.",
                              "old": "The phone number in E.164 format."
                            }
                          },
                          {
                            "@added_9d80433bbcf847ef8d4e31750316b8b1": {
                              "#name": "isAnonymous",
                              "Description": "True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.",
                              "Required": false,
                              "Type": "boolean"
                            }
                          },
                          {
                            "@added_54c258cd9ba34a7fb8819e08a0d5f676": {
                              "#name": "assertedId",
                              "Description": "The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.",
                              "Required": false,
                              "Type": "string"
                            }
                          }
                        ]
                      },
                      {
                        "microsoftTeamsUser": [
                          {
                            "#name": "userId",
                            "Description": {
                              "new": "The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.",
                              "old": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user."
                            }
                          }
                        ]
                      },
                      {
                        "@added_e6cd1f1e486045919635cb6eb2cb9838": {
                          "#name": "teamsExtensionUser",
                          "Description": "The Microsoft Teams Extension user.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "userId",
                              "Description": "The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.",
                              "Required": true,
                              "Type": "string"
                            },
                            {
                              "#name": "tenantId",
                              "Description": "The tenant Id of the Microsoft Teams Extension user.",
                              "Required": true,
                              "Type": "string"
                            },
                            {
                              "#name": "resourceId",
                              "Description": "The Communication Services resource Id.",
                              "Required": true,
                              "Type": "string"
                            },
                            {
                              "#name": "cloud",
                              "Description": "The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing.",
                              "Enum": [
                                [
                                  "public",
                                  ""
                                ],
                                [
                                  "dod",
                                  ""
                                ],
                                [
                                  "gcch",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        }
                      }
                    ]
                  }
                }
              },
              {
                "initiatorCommunicationIdentifier": [
                  {
                    "#name": "kind",
                    "Enum": {
                      "new": [
                        [
                          "unknown",
                          ""
                        ],
                        [
                          "communicationUser",
                          ""
                        ],
                        [
                          "phoneNumber",
                          ""
                        ],
                        [
                          "microsoftTeamsUser",
                          ""
                        ],
                        [
                          "microsoftTeamsApp",
                          ""
                        ],
                        [
                          "teamsExtensionUser",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "unknown",
                          ""
                        ],
                        [
                          "communicationUser",
                          ""
                        ],
                        [
                          "phoneNumber",
                          ""
                        ],
                        [
                          "microsoftTeamsUser",
                          ""
                        ],
                        [
                          "microsoftTeamsApp",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "phoneNumber": [
                      {
                        "#name": "value",
                        "Description": {
                          "new": "The phone number, usually in E.164 format.",
                          "old": "The phone number in E.164 format."
                        }
                      },
                      {
                        "@added_c1166f94c4f34b2d9d21a17339b46637": {
                          "#name": "isAnonymous",
                          "Description": "True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.",
                          "Required": false,
                          "Type": "boolean"
                        }
                      },
                      {
                        "@added_218bedc4c26141158e4832fc344526d9": {
                          "#name": "assertedId",
                          "Description": "The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.",
                          "Required": false,
                          "Type": "string"
                        }
                      }
                    ]
                  },
                  {
                    "microsoftTeamsUser": [
                      {
                        "#name": "userId",
                        "Description": {
                          "new": "The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.",
                          "old": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user."
                        }
                      }
                    ]
                  },
                  {
                    "@added_ba00c9becb224f61b175afd44ab01f19": {
                      "#name": "teamsExtensionUser",
                      "Description": "The Microsoft Teams Extension user.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "userId",
                          "Description": "The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.",
                          "Required": true,
                          "Type": "string"
                        },
                        {
                          "#name": "tenantId",
                          "Description": "The tenant Id of the Microsoft Teams Extension user.",
                          "Required": true,
                          "Type": "string"
                        },
                        {
                          "#name": "resourceId",
                          "Description": "The Communication Services resource Id.",
                          "Required": true,
                          "Type": "string"
                        },
                        {
                          "#name": "cloud",
                          "Description": "The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing.",
                          "Enum": [
                            [
                              "public",
                              ""
                            ],
                            [
                              "dod",
                              ""
                            ],
                            [
                              "gcch",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            ],
            "senderCommunicationIdentifier": [
              {
                "#name": "kind",
                "Enum": {
                  "new": [
                    [
                      "unknown",
                      ""
                    ],
                    [
                      "communicationUser",
                      ""
                    ],
                    [
                      "phoneNumber",
                      ""
                    ],
                    [
                      "microsoftTeamsUser",
                      ""
                    ],
                    [
                      "microsoftTeamsApp",
                      ""
                    ],
                    [
                      "teamsExtensionUser",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "unknown",
                      ""
                    ],
                    [
                      "communicationUser",
                      ""
                    ],
                    [
                      "phoneNumber",
                      ""
                    ],
                    [
                      "microsoftTeamsUser",
                      ""
                    ],
                    [
                      "microsoftTeamsApp",
                      ""
                    ]
                  ]
                }
              },
              {
                "phoneNumber": [
                  {
                    "#name": "value",
                    "Description": {
                      "new": "The phone number, usually in E.164 format.",
                      "old": "The phone number in E.164 format."
                    }
                  },
                  {
                    "@added_d3badd83667046bcbc20e8a189d72909": {
                      "#name": "isAnonymous",
                      "Description": "True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.",
                      "Required": false,
                      "Type": "boolean"
                    }
                  },
                  {
                    "@added_5a87003d0ab64087a5640b1b29cd2599": {
                      "#name": "assertedId",
                      "Description": "The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.",
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              },
              {
                "microsoftTeamsUser": [
                  {
                    "#name": "userId",
                    "Description": {
                      "new": "The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.",
                      "old": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user."
                    }
                  }
                ]
              },
              {
                "@added_5a6cda6e492046719931ea73838576f9": {
                  "#name": "teamsExtensionUser",
                  "Description": "The Microsoft Teams Extension user.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "userId",
                      "Description": "The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "tenantId",
                      "Description": "The tenant Id of the Microsoft Teams Extension user.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceId",
                      "Description": "The Communication Services resource Id.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "cloud",
                      "Description": "The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing.",
                      "Enum": [
                        [
                          "public",
                          ""
                        ],
                        [
                          "dod",
                          ""
                        ],
                        [
                          "gcch",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /chat/threads/{chatThreadId}/messages
{
chatThreadId:
{
Description: The thread id of the message. ,
Required: True ,
}
string ,
maxPageSize:
{
Description: The maximum number of messages to be returned per page. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The earliest point in time to get messages after. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Collection of chat messages. ,
Required: True ,
}
[
{
id:
{
Description: The id of the chat message. This id is server generated. ,
Required: True ,
}
string ,
type:
{
Description: The chat message type. ,
Enum:
{
text: No description available. ,
html: No description available. ,
topicUpdated: No description available. ,
participantAdded: No description available. ,
participantRemoved: No description available. ,
}
,
Required: True ,
}
enum ,
sequenceId:
{
Description: Sequence of the chat message in the conversation. ,
Required: True ,
}
string ,
version:
{
Description: Version of the chat message. ,
Required: True ,
}
string ,
content:
{
Description: Content of a chat message. ,
Required: False ,
}
{
message:
{
Description: Chat message content for messages of types text or html. ,
Required: False ,
}
string ,
topic:
{
Description: Chat message content for messages of type topicUpdated. ,
Required: False ,
}
string ,
participants:
{
Description: Chat message content for messages of types participantAdded or participantRemoved. ,
Required: False ,
}
[
{
communicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
displayName:
{
Description: Display name for the chat participant. ,
Required: False ,
}
string ,
shareHistoryTime:
{
Description: Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the chat participant. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
}
,
]
,
attachments:
{
Description: List of attachments for this message ,
Required: False ,
}
[
{
id:
{
Description: Id of the attachment ,
Required: True ,
}
string ,
attachmentType:
{
Description: The type of attachment. ,
Enum:
{
image: No description available. ,
file: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the attachment content. ,
Required: False ,
}
string ,
url:
{
Description: The URL where the attachment can be downloaded ,
Format: uri ,
Required: False ,
}
string ,
previewUrl:
{
Description: The URL where the preview of attachment can be downloaded ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
initiatorCommunicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
senderDisplayName:
{
Description: The display name of the chat message sender. This property is used to populate sender name for push notifications. ,
Required: False ,
}
string ,
createdOn:
{
Description: The timestamp when the chat message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
senderCommunicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
deletedOn:
{
Description: The timestamp (if applicable) when the message was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
editedOn:
{
Description: The last timestamp (if applicable) when the message was edited. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Message metadata. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: If there are more chat messages that can be retrieved, the next link will be populated. ,
Required: False ,
}
string ,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_GetChatMessage (updated)
Description :  Gets a message by id.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ChatThread_GetChatMessage",
  "$responses": {
    "200": {
      "$properties": {
        "content": [
          {
            "participants": {
              "$properties": {
                "communicationIdentifier": [
                  {
                    "#name": "kind",
                    "Enum": {
                      "new": [
                        [
                          "unknown",
                          ""
                        ],
                        [
                          "communicationUser",
                          ""
                        ],
                        [
                          "phoneNumber",
                          ""
                        ],
                        [
                          "microsoftTeamsUser",
                          ""
                        ],
                        [
                          "microsoftTeamsApp",
                          ""
                        ],
                        [
                          "teamsExtensionUser",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "unknown",
                          ""
                        ],
                        [
                          "communicationUser",
                          ""
                        ],
                        [
                          "phoneNumber",
                          ""
                        ],
                        [
                          "microsoftTeamsUser",
                          ""
                        ],
                        [
                          "microsoftTeamsApp",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "phoneNumber": [
                      {
                        "#name": "value",
                        "Description": {
                          "new": "The phone number, usually in E.164 format.",
                          "old": "The phone number in E.164 format."
                        }
                      },
                      {
                        "@added_b65b04b27ea543198064c8c9c9ac8f13": {
                          "#name": "isAnonymous",
                          "Description": "True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.",
                          "Required": false,
                          "Type": "boolean"
                        }
                      },
                      {
                        "@added_989c53b272b04e39a9210fe70afa3e40": {
                          "#name": "assertedId",
                          "Description": "The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.",
                          "Required": false,
                          "Type": "string"
                        }
                      }
                    ]
                  },
                  {
                    "microsoftTeamsUser": [
                      {
                        "#name": "userId",
                        "Description": {
                          "new": "The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.",
                          "old": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user."
                        }
                      }
                    ]
                  },
                  {
                    "@added_45357db9e61748a995edec93922c2ef3": {
                      "#name": "teamsExtensionUser",
                      "Description": "The Microsoft Teams Extension user.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "userId",
                          "Description": "The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.",
                          "Required": true,
                          "Type": "string"
                        },
                        {
                          "#name": "tenantId",
                          "Description": "The tenant Id of the Microsoft Teams Extension user.",
                          "Required": true,
                          "Type": "string"
                        },
                        {
                          "#name": "resourceId",
                          "Description": "The Communication Services resource Id.",
                          "Required": true,
                          "Type": "string"
                        },
                        {
                          "#name": "cloud",
                          "Description": "The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing.",
                          "Enum": [
                            [
                              "public",
                              ""
                            ],
                            [
                              "dod",
                              ""
                            ],
                            [
                              "gcch",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "initiatorCommunicationIdentifier": [
              {
                "#name": "kind",
                "Enum": {
                  "new": [
                    [
                      "unknown",
                      ""
                    ],
                    [
                      "communicationUser",
                      ""
                    ],
                    [
                      "phoneNumber",
                      ""
                    ],
                    [
                      "microsoftTeamsUser",
                      ""
                    ],
                    [
                      "microsoftTeamsApp",
                      ""
                    ],
                    [
                      "teamsExtensionUser",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "unknown",
                      ""
                    ],
                    [
                      "communicationUser",
                      ""
                    ],
                    [
                      "phoneNumber",
                      ""
                    ],
                    [
                      "microsoftTeamsUser",
                      ""
                    ],
                    [
                      "microsoftTeamsApp",
                      ""
                    ]
                  ]
                }
              },
              {
                "phoneNumber": [
                  {
                    "#name": "value",
                    "Description": {
                      "new": "The phone number, usually in E.164 format.",
                      "old": "The phone number in E.164 format."
                    }
                  },
                  {
                    "@added_224bf070df7d4dc3a9972bbf39d60334": {
                      "#name": "isAnonymous",
                      "Description": "True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.",
                      "Required": false,
                      "Type": "boolean"
                    }
                  },
                  {
                    "@added_fb605a05243e450f898b183609de1dcd": {
                      "#name": "assertedId",
                      "Description": "The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.",
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              },
              {
                "microsoftTeamsUser": [
                  {
                    "#name": "userId",
                    "Description": {
                      "new": "The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.",
                      "old": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user."
                    }
                  }
                ]
              },
              {
                "@added_54bc8170ee8246da8c8a8a6dcd467ae8": {
                  "#name": "teamsExtensionUser",
                  "Description": "The Microsoft Teams Extension user.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "userId",
                      "Description": "The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "tenantId",
                      "Description": "The tenant Id of the Microsoft Teams Extension user.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceId",
                      "Description": "The Communication Services resource Id.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "cloud",
                      "Description": "The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing.",
                      "Enum": [
                        [
                          "public",
                          ""
                        ],
                        [
                          "dod",
                          ""
                        ],
                        [
                          "gcch",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        ],
        "senderCommunicationIdentifier": [
          {
            "#name": "kind",
            "Enum": {
              "new": [
                [
                  "unknown",
                  ""
                ],
                [
                  "communicationUser",
                  ""
                ],
                [
                  "phoneNumber",
                  ""
                ],
                [
                  "microsoftTeamsUser",
                  ""
                ],
                [
                  "microsoftTeamsApp",
                  ""
                ],
                [
                  "teamsExtensionUser",
                  ""
                ]
              ],
              "old": [
                [
                  "unknown",
                  ""
                ],
                [
                  "communicationUser",
                  ""
                ],
                [
                  "phoneNumber",
                  ""
                ],
                [
                  "microsoftTeamsUser",
                  ""
                ],
                [
                  "microsoftTeamsApp",
                  ""
                ]
              ]
            }
          },
          {
            "phoneNumber": [
              {
                "#name": "value",
                "Description": {
                  "new": "The phone number, usually in E.164 format.",
                  "old": "The phone number in E.164 format."
                }
              },
              {
                "@added_0af8a42473454167b53c9a84c81c9288": {
                  "#name": "isAnonymous",
                  "Description": "True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.",
                  "Required": false,
                  "Type": "boolean"
                }
              },
              {
                "@added_cc914ffec0e54d17b1a274217af071a9": {
                  "#name": "assertedId",
                  "Description": "The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.",
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          },
          {
            "microsoftTeamsUser": [
              {
                "#name": "userId",
                "Description": {
                  "new": "The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.",
                  "old": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user."
                }
              }
            ]
          },
          {
            "@added_d62a599ac62940cc9353af5d45dbb42f": {
              "#name": "teamsExtensionUser",
              "Description": "The Microsoft Teams Extension user.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "userId",
                  "Description": "The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.",
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "tenantId",
                  "Description": "The tenant Id of the Microsoft Teams Extension user.",
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "resourceId",
                  "Description": "The Communication Services resource Id.",
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "cloud",
                  "Description": "The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing.",
                  "Enum": [
                    [
                      "public",
                      ""
                    ],
                    [
                      "dod",
                      ""
                    ],
                    [
                      "gcch",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /chat/threads/{chatThreadId}/messages/{chatMessageId}
{
chatThreadId:
{
Description: The thread id to which the message was sent. ,
Required: True ,
}
string ,
chatMessageId:
{
Description: The message id. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the chat message. This id is server generated. ,
Required: True ,
}
string ,
type:
{
Description: The chat message type. ,
Enum:
{
text: No description available. ,
html: No description available. ,
topicUpdated: No description available. ,
participantAdded: No description available. ,
participantRemoved: No description available. ,
}
,
Required: True ,
}
enum ,
sequenceId:
{
Description: Sequence of the chat message in the conversation. ,
Required: True ,
}
string ,
version:
{
Description: Version of the chat message. ,
Required: True ,
}
string ,
content:
{
Description: Content of a chat message. ,
Required: False ,
}
{
message:
{
Description: Chat message content for messages of types text or html. ,
Required: False ,
}
string ,
topic:
{
Description: Chat message content for messages of type topicUpdated. ,
Required: False ,
}
string ,
participants:
{
Description: Chat message content for messages of types participantAdded or participantRemoved. ,
Required: False ,
}
[
{
communicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
displayName:
{
Description: Display name for the chat participant. ,
Required: False ,
}
string ,
shareHistoryTime:
{
Description: Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the chat participant. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
}
,
]
,
attachments:
{
Description: List of attachments for this message ,
Required: False ,
}
[
{
id:
{
Description: Id of the attachment ,
Required: True ,
}
string ,
attachmentType:
{
Description: The type of attachment. ,
Enum:
{
image: No description available. ,
file: No description available. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: The name of the attachment content. ,
Required: False ,
}
string ,
url:
{
Description: The URL where the attachment can be downloaded ,
Format: uri ,
Required: False ,
}
string ,
previewUrl:
{
Description: The URL where the preview of attachment can be downloaded ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
initiatorCommunicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
senderDisplayName:
{
Description: The display name of the chat message sender. This property is used to populate sender name for push notifications. ,
Required: False ,
}
string ,
createdOn:
{
Description: The timestamp when the chat message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
senderCommunicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: False ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
deletedOn:
{
Description: The timestamp (if applicable) when the message was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
editedOn:
{
Description: The last timestamp (if applicable) when the message was edited. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Message metadata. ,
Required: False ,
}
object ,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_ListChatParticipants (updated)
Description :  Gets the participants of a thread.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ChatThread_ListChatParticipants",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "communicationIdentifier": [
              {
                "#name": "kind",
                "Enum": {
                  "new": [
                    [
                      "unknown",
                      ""
                    ],
                    [
                      "communicationUser",
                      ""
                    ],
                    [
                      "phoneNumber",
                      ""
                    ],
                    [
                      "microsoftTeamsUser",
                      ""
                    ],
                    [
                      "microsoftTeamsApp",
                      ""
                    ],
                    [
                      "teamsExtensionUser",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "unknown",
                      ""
                    ],
                    [
                      "communicationUser",
                      ""
                    ],
                    [
                      "phoneNumber",
                      ""
                    ],
                    [
                      "microsoftTeamsUser",
                      ""
                    ],
                    [
                      "microsoftTeamsApp",
                      ""
                    ]
                  ]
                }
              },
              {
                "phoneNumber": [
                  {
                    "#name": "value",
                    "Description": {
                      "new": "The phone number, usually in E.164 format.",
                      "old": "The phone number in E.164 format."
                    }
                  },
                  {
                    "@added_1f915e649050474ea8e0769b3e87a32b": {
                      "#name": "isAnonymous",
                      "Description": "True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.",
                      "Required": false,
                      "Type": "boolean"
                    }
                  },
                  {
                    "@added_d8f7e5363745453a827f1069f469d016": {
                      "#name": "assertedId",
                      "Description": "The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.",
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              },
              {
                "microsoftTeamsUser": [
                  {
                    "#name": "userId",
                    "Description": {
                      "new": "The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.",
                      "old": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user."
                    }
                  }
                ]
              },
              {
                "@added_2b19d6c72e974792b2b0ad8c05542e6f": {
                  "#name": "teamsExtensionUser",
                  "Description": "The Microsoft Teams Extension user.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "userId",
                      "Description": "The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "tenantId",
                      "Description": "The tenant Id of the Microsoft Teams Extension user.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceId",
                      "Description": "The Communication Services resource Id.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "cloud",
                      "Description": "The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing.",
                      "Enum": [
                        [
                          "public",
                          ""
                        ],
                        [
                          "dod",
                          ""
                        ],
                        [
                          "gcch",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /chat/threads/{chatThreadId}/participants
{
chatThreadId:
{
Description: Thread id to get participants for. ,
Required: True ,
}
string ,
maxPageSize:
{
Description: The maximum number of participants to be returned per page. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: Skips participants up to a specified position in response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Chat participants. ,
Required: True ,
}
[
{
communicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
displayName:
{
Description: Display name for the chat participant. ,
Required: False ,
}
string ,
shareHistoryTime:
{
Description: Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the chat participant. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: If there are more chat participants that can be retrieved, the next link will be populated. ,
Required: False ,
}
string ,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_RemoveChatParticipant (updated)
Description :  Remove a participant from a thread.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ChatThread_RemoveChatParticipant",
  "$parameters": {
    "participantCommunicationIdentifier": {
      "$properties": [
        {
          "#name": "kind",
          "Enum": {
            "new": [
              [
                "unknown",
                ""
              ],
              [
                "communicationUser",
                ""
              ],
              [
                "phoneNumber",
                ""
              ],
              [
                "microsoftTeamsUser",
                ""
              ],
              [
                "microsoftTeamsApp",
                ""
              ],
              [
                "teamsExtensionUser",
                ""
              ]
            ],
            "old": [
              [
                "unknown",
                ""
              ],
              [
                "communicationUser",
                ""
              ],
              [
                "phoneNumber",
                ""
              ],
              [
                "microsoftTeamsUser",
                ""
              ],
              [
                "microsoftTeamsApp",
                ""
              ]
            ]
          }
        },
        {
          "phoneNumber": [
            {
              "#name": "value",
              "Description": {
                "new": "The phone number, usually in E.164 format.",
                "old": "The phone number in E.164 format."
              }
            },
            {
              "@added_d19a9dfa791043a0bece9482f18de8e6": {
                "#name": "isAnonymous",
                "Description": "True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.",
                "Required": false,
                "Type": "boolean"
              }
            },
            {
              "@added_f70c7bd39e1c4fa7adba234a239416eb": {
                "#name": "assertedId",
                "Description": "The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.",
                "Required": false,
                "Type": "string"
              }
            }
          ]
        },
        {
          "microsoftTeamsUser": [
            {
              "#name": "userId",
              "Description": {
                "new": "The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.",
                "old": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user."
              }
            }
          ]
        },
        {
          "@added_f4cb85430263419fb5753916adec6eff": {
            "#name": "teamsExtensionUser",
            "Description": "The Microsoft Teams Extension user.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "userId",
                "Description": "The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "tenantId",
                "Description": "The tenant Id of the Microsoft Teams Extension user.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "resourceId",
                "Description": "The Communication Services resource Id.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "cloud",
                "Description": "The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing.",
                "Enum": [
                  [
                    "public",
                    ""
                  ],
                  [
                    "dod",
                    ""
                  ],
                  [
                    "gcch",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /chat/threads/{chatThreadId}/participants/:remove
{
chatThreadId:
{
Description: Thread id to remove the participant from. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
participantCommunicationIdentifier:
{
Description: Id of the thread participant to remove from the thread. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_AddChatParticipants (updated)
Description :  Adds thread participants to a thread. If participants already exist, no change occurs.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ChatThread_AddChatParticipants",
  "$parameters": {
    "addChatParticipantsRequest": {
      "$properties": {
        "participants": {
          "$properties": {
            "communicationIdentifier": [
              {
                "#name": "kind",
                "Enum": {
                  "new": [
                    [
                      "unknown",
                      ""
                    ],
                    [
                      "communicationUser",
                      ""
                    ],
                    [
                      "phoneNumber",
                      ""
                    ],
                    [
                      "microsoftTeamsUser",
                      ""
                    ],
                    [
                      "microsoftTeamsApp",
                      ""
                    ],
                    [
                      "teamsExtensionUser",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "unknown",
                      ""
                    ],
                    [
                      "communicationUser",
                      ""
                    ],
                    [
                      "phoneNumber",
                      ""
                    ],
                    [
                      "microsoftTeamsUser",
                      ""
                    ],
                    [
                      "microsoftTeamsApp",
                      ""
                    ]
                  ]
                }
              },
              {
                "phoneNumber": [
                  {
                    "#name": "value",
                    "Description": {
                      "new": "The phone number, usually in E.164 format.",
                      "old": "The phone number in E.164 format."
                    }
                  },
                  {
                    "@added_3dff1874c2bf4a4bb3c335d6c3bb76bf": {
                      "#name": "isAnonymous",
                      "Description": "True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.",
                      "Required": false,
                      "Type": "boolean"
                    }
                  },
                  {
                    "@added_c3d0d6f657b64955a3a1e8a85b765394": {
                      "#name": "assertedId",
                      "Description": "The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.",
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              },
              {
                "microsoftTeamsUser": [
                  {
                    "#name": "userId",
                    "Description": {
                      "new": "The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.",
                      "old": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user."
                    }
                  }
                ]
              },
              {
                "@added_80e13694b24c482ead25e57232cf2601": {
                  "#name": "teamsExtensionUser",
                  "Description": "The Microsoft Teams Extension user.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "userId",
                      "Description": "The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "tenantId",
                      "Description": "The tenant Id of the Microsoft Teams Extension user.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceId",
                      "Description": "The Communication Services resource Id.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "cloud",
                      "Description": "The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing.",
                      "Enum": [
                        [
                          "public",
                          ""
                        ],
                        [
                          "dod",
                          ""
                        ],
                        [
                          "gcch",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

POST:  /chat/threads/{chatThreadId}/participants/:add
{
chatThreadId:
{
Description: Id of the thread to add participants to. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
addChatParticipantsRequest:
{
Description: Thread participants to be added to the thread. ,
Required: True ,
}
{
participants:
{
Description: Participants to add to a chat thread. ,
Required: True ,
}
[
{
communicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
displayName:
{
Description: Display name for the chat participant. ,
Required: False ,
}
string ,
shareHistoryTime:
{
Description: Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the chat participant. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (201)

{
invalidParticipants:
{
Description: The participants that failed to be added to the chat thread. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
Chat_CreateChatThread (updated)
Description :  Creates a chat thread.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Chat_CreateChatThread",
  "$parameters": {
    "createChatThreadRequest": {
      "$properties": {
        "participants": {
          "$properties": {
            "communicationIdentifier": [
              {
                "#name": "kind",
                "Enum": {
                  "new": [
                    [
                      "unknown",
                      ""
                    ],
                    [
                      "communicationUser",
                      ""
                    ],
                    [
                      "phoneNumber",
                      ""
                    ],
                    [
                      "microsoftTeamsUser",
                      ""
                    ],
                    [
                      "microsoftTeamsApp",
                      ""
                    ],
                    [
                      "teamsExtensionUser",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "unknown",
                      ""
                    ],
                    [
                      "communicationUser",
                      ""
                    ],
                    [
                      "phoneNumber",
                      ""
                    ],
                    [
                      "microsoftTeamsUser",
                      ""
                    ],
                    [
                      "microsoftTeamsApp",
                      ""
                    ]
                  ]
                }
              },
              {
                "phoneNumber": [
                  {
                    "#name": "value",
                    "Description": {
                      "new": "The phone number, usually in E.164 format.",
                      "old": "The phone number in E.164 format."
                    }
                  },
                  {
                    "@added_53cad1799aa84e70a87710a7150c8d4d": {
                      "#name": "isAnonymous",
                      "Description": "True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.",
                      "Required": false,
                      "Type": "boolean"
                    }
                  },
                  {
                    "@added_d4aae759d1e74670b3aa13f1eb86569d": {
                      "#name": "assertedId",
                      "Description": "The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.",
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              },
              {
                "microsoftTeamsUser": [
                  {
                    "#name": "userId",
                    "Description": {
                      "new": "The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.",
                      "old": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user."
                    }
                  }
                ]
              },
              {
                "@added_5d007c533c4d4b8580ffa6a784950a3f": {
                  "#name": "teamsExtensionUser",
                  "Description": "The Microsoft Teams Extension user.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "userId",
                      "Description": "The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "tenantId",
                      "Description": "The tenant Id of the Microsoft Teams Extension user.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceId",
                      "Description": "The Communication Services resource Id.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "cloud",
                      "Description": "The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing.",
                      "Enum": [
                        [
                          "public",
                          ""
                        ],
                        [
                          "dod",
                          ""
                        ],
                        [
                          "gcch",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  },
  "$responses": {
    "201": {
      "$properties": {
        "chatThread": [
          {
            "createdByCommunicationIdentifier": [
              {
                "#name": "kind",
                "Enum": {
                  "new": [
                    [
                      "unknown",
                      ""
                    ],
                    [
                      "communicationUser",
                      ""
                    ],
                    [
                      "phoneNumber",
                      ""
                    ],
                    [
                      "microsoftTeamsUser",
                      ""
                    ],
                    [
                      "microsoftTeamsApp",
                      ""
                    ],
                    [
                      "teamsExtensionUser",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "unknown",
                      ""
                    ],
                    [
                      "communicationUser",
                      ""
                    ],
                    [
                      "phoneNumber",
                      ""
                    ],
                    [
                      "microsoftTeamsUser",
                      ""
                    ],
                    [
                      "microsoftTeamsApp",
                      ""
                    ]
                  ]
                }
              },
              {
                "phoneNumber": [
                  {
                    "#name": "value",
                    "Description": {
                      "new": "The phone number, usually in E.164 format.",
                      "old": "The phone number in E.164 format."
                    }
                  },
                  {
                    "@added_580400f9544a4635b89f625c03cbf207": {
                      "#name": "isAnonymous",
                      "Description": "True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.",
                      "Required": false,
                      "Type": "boolean"
                    }
                  },
                  {
                    "@added_1a192af89f3643ecb9ce48b25d5e166a": {
                      "#name": "assertedId",
                      "Description": "The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.",
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              },
              {
                "microsoftTeamsUser": [
                  {
                    "#name": "userId",
                    "Description": {
                      "new": "The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.",
                      "old": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user."
                    }
                  }
                ]
              },
              {
                "@added_14989fb70ea44e49b43de12ddc2badad": {
                  "#name": "teamsExtensionUser",
                  "Description": "The Microsoft Teams Extension user.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "userId",
                      "Description": "The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "tenantId",
                      "Description": "The tenant Id of the Microsoft Teams Extension user.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceId",
                      "Description": "The Communication Services resource Id.",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "cloud",
                      "Description": "The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing.",
                      "Enum": [
                        [
                          "public",
                          ""
                        ],
                        [
                          "dod",
                          ""
                        ],
                        [
                          "gcch",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /chat/threads
{
repeatability-request-id:
{
Description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
createChatThreadRequest:
{
Description: Request payload for creating a chat thread. ,
Required: True ,
}
{
topic:
{
Description: The chat thread topic. ,
Required: True ,
}
string ,
participants:
{
Description: Participants to be added to the chat thread. ,
Required: False ,
}
[
{
communicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
displayName:
{
Description: Display name for the chat participant. ,
Required: False ,
}
string ,
shareHistoryTime:
{
Description: Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the chat participant. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
}
,
]
,
metadata:
{
Description: Contextual metadata for the thread. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
retentionPolicy:
{
Description: Data retention policy for auto deletion. ,
Required: False ,
}
{
kind:
{
Description: Retention Policy Type ,
Enum:
{
threadCreationDate: Thread retention policy based on thread creation date. ,
none: No thread retention policy ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
chatThread:
{
Description: Chat thread. ,
Required: False ,
}
{
id:
{
Description: Chat thread id. ,
Required: True ,
}
string ,
topic:
{
Description: Chat thread topic. ,
Required: True ,
}
string ,
createdOn:
{
Description: The timestamp when the chat thread was created. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
createdByCommunicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
deletedOn:
{
Description: The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the thread. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
retentionPolicy:
{
Description: Data retention policy for auto deletion. ,
Required: False ,
}
{
kind:
{
Description: Retention Policy Type ,
Enum:
{
threadCreationDate: Thread retention policy based on thread creation date. ,
none: No thread retention policy ,
}
,
Required: True ,
}
enum ,
}
,
}
,
invalidParticipants:
{
Description: The participants that failed to be added to the chat thread. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}
ChatThread_GetChatThreadProperties (updated)
Description :  Gets a chat thread's properties.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ChatThread_GetChatThreadProperties",
  "$responses": {
    "200": {
      "$properties": {
        "createdByCommunicationIdentifier": [
          {
            "#name": "kind",
            "Enum": {
              "new": [
                [
                  "unknown",
                  ""
                ],
                [
                  "communicationUser",
                  ""
                ],
                [
                  "phoneNumber",
                  ""
                ],
                [
                  "microsoftTeamsUser",
                  ""
                ],
                [
                  "microsoftTeamsApp",
                  ""
                ],
                [
                  "teamsExtensionUser",
                  ""
                ]
              ],
              "old": [
                [
                  "unknown",
                  ""
                ],
                [
                  "communicationUser",
                  ""
                ],
                [
                  "phoneNumber",
                  ""
                ],
                [
                  "microsoftTeamsUser",
                  ""
                ],
                [
                  "microsoftTeamsApp",
                  ""
                ]
              ]
            }
          },
          {
            "phoneNumber": [
              {
                "#name": "value",
                "Description": {
                  "new": "The phone number, usually in E.164 format.",
                  "old": "The phone number in E.164 format."
                }
              },
              {
                "@added_2aadb3f96b314ba8b4b61abd9acb9287": {
                  "#name": "isAnonymous",
                  "Description": "True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'.",
                  "Required": false,
                  "Type": "boolean"
                }
              },
              {
                "@added_55d4f4bd68e54f9fa981185b08c4c9e1": {
                  "#name": "assertedId",
                  "Description": "The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once.",
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          },
          {
            "microsoftTeamsUser": [
              {
                "#name": "userId",
                "Description": {
                  "new": "The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.",
                  "old": "The Id of the Microsoft Teams user. If not anonymous, this is the AAD object Id of the user."
                }
              }
            ]
          },
          {
            "@added_2d24f4411e054e32aee8a9069bc39074": {
              "#name": "teamsExtensionUser",
              "Description": "The Microsoft Teams Extension user.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "userId",
                  "Description": "The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user.",
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "tenantId",
                  "Description": "The tenant Id of the Microsoft Teams Extension user.",
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "resourceId",
                  "Description": "The Communication Services resource Id.",
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "cloud",
                  "Description": "The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing.",
                  "Enum": [
                    [
                      "public",
                      ""
                    ],
                    [
                      "dod",
                      ""
                    ],
                    [
                      "gcch",
                      ""
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /chat/threads/{chatThreadId}
{
chatThreadId:
{
Description: Id of the thread. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Chat thread id. ,
Required: True ,
}
string ,
topic:
{
Description: Chat thread topic. ,
Required: True ,
}
string ,
createdOn:
{
Description: The timestamp when the chat thread was created. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: True ,
}
string ,
createdByCommunicationIdentifier:
{
Description: Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value. ,
Required: True ,
}
{
kind:
{
Description: The identifier kind. Only required in responses. ,
Enum:
{
unknown: No description available. ,
communicationUser: No description available. ,
phoneNumber: No description available. ,
microsoftTeamsUser: No description available. ,
microsoftTeamsApp: No description available. ,
teamsExtensionUser: No description available. ,
}
,
Required: False ,
}
enum ,
rawId:
{
Description: Raw Id of the identifier. Optional in requests, required in responses. ,
Required: False ,
}
string ,
communicationUser:
{
Description: The communication user. ,
Required: False ,
}
{
id:
{
Description: The Id of the communication user. ,
Required: True ,
}
string ,
}
,
phoneNumber:
{
Description: The phone number. ,
Required: False ,
}
{
value:
{
Description: The phone number, usually in E.164 format. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the phone number is anonymous. By default false if missing. If the phone number is anonymous, the value will be the string 'anonymous'. ,
Required: False ,
}
boolean ,
assertedId:
{
Description: The asserted Id of the phone number. An asserted Id gets generated when the same phone number joins the same call more than once. ,
Required: False ,
}
string ,
}
,
microsoftTeamsUser:
{
Description: The Microsoft Teams user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user. ,
Required: True ,
}
string ,
isAnonymous:
{
Description: True if the Microsoft Teams user is anonymous. By default false if missing. ,
Required: False ,
}
boolean ,
cloud:
{
Description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
microsoftTeamsApp:
{
Description: The Microsoft Teams application. ,
Required: False ,
}
{
appId:
{
Description: The Id of the Microsoft Teams application. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
teamsExtensionUser:
{
Description: The Microsoft Teams Extension user. ,
Required: False ,
}
{
userId:
{
Description: The Id of the Microsoft Teams Extension user, i.e. the Entra ID object Id of the user. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant Id of the Microsoft Teams Extension user. ,
Required: True ,
}
string ,
resourceId:
{
Description: The Communication Services resource Id. ,
Required: True ,
}
string ,
cloud:
{
Description: The cloud that the Microsoft Teams Extension user belongs to. By default 'public' if missing. ,
Enum:
{
public: No description available. ,
dod: No description available. ,
gcch: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
deletedOn:
{
Description: The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: Contextual metadata for the thread. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size. ,
Required: False ,
}
object ,
retentionPolicy:
{
Description: Data retention policy for auto deletion. ,
Required: False ,
}
{
kind:
{
Description: Retention Policy Type ,
Enum:
{
threadCreationDate: Thread retention policy based on thread creation date. ,
none: No thread retention policy ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (401)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (403)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (503)

{
error:
{
Description: The Communication Services error. ,
Required: True ,
}
{
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Further details about specific errors that led to this error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Required: False ,
}
string ,
}
,
}